Make aasm compiler v6.0 aware - #2672
Merged
Merged
Conversation
Contributor
Author
|
I have signed the CLA! |
KaanOzkan
reviewed
Jul 16, 2026
|
|
||
| sig { params(opts: T.untyped, block: T.nilable(T.proc.void)).returns(T.untyped) } | ||
| def run_without_validation!(*opts, &block); end | ||
| def run_foo_without_validation!(*opts, &block); end |
Contributor
There was a problem hiding this comment.
Thanks for the PR. Since this version is brand new, I'd prefer if we kept older tests, we have a similar pattern in here. It is then executed as ERB in here.
I think you can define a similar helper in this file:
def aasm_version(selector)
::Gem::Requirement.new(selector).satisfied_by?(::Gem::Version.new(::AASM::VERSION))
end
Contributor
Author
There was a problem hiding this comment.
Ah, perfect! Thanks for linking those. Updated!
Contributor
Author
There was a problem hiding this comment.
I'm realizing now that there's no tooling currently (like Rails in the CI matrix) that actually installs and drives the test suite for the older version of aasm. I'll push up a commit to stub this out in tests vs. adding another variant to the test matrix (this seemed heavy, and not quite on the same level as Ruby/Rails). I've included sample implementations for both below, so LMK if you'd prefer the other!
Test matrix
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index cc6424c9..7f487af6 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -44,6 +44,7 @@ jobs:
ruby: ["3.2", "3.3", "3.4", "4.0","head"]
rails: ["8.0", "current", "main"]
rubygems: ["4.0.10"]
+ aasm: ["current"]
exclude:
- ruby: "3.2"
rails: "main"
@@ -52,9 +53,13 @@ jobs:
experimental: true
- ruby: "head"
experimental: true
- name: Ruby ${{ matrix.ruby }} - Rails ${{ matrix.rails }} - RubyGems ${{ matrix.rubygems }}
+ - ruby: "3.4"
+ rails: "current"
+ aasm: "5.5"
+ name: Ruby ${{ matrix.ruby }} - Rails ${{ matrix.rails }} - RubyGems ${{ matrix.rubygems }} - AASM ${{ matrix.aasm }}
env:
RAILS_VERSION: ${{ matrix.rails }}
+ AASM_VERSION: ${{ matrix.aasm }}
steps:
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
- name: Install protobuf
diff --git a/Gemfile b/Gemfile
index 43b343c3..83e695fa 100644
--- a/Gemfile
+++ b/Gemfile
@@ -7,6 +7,8 @@ gemspec
CURRENT_RAILS_VERSION = "8.1"
rails_version = ENV.fetch("RAILS_VERSION", CURRENT_RAILS_VERSION)
+aasm_version = ENV.fetch("AASM_VERSION", "current")
+
gem "minitest"
gem "minitest-hooks"
gem "minitest-reporters"
@@ -52,7 +54,11 @@ group :development, :test do
gem "sidekiq"
gem "nokogiri"
gem "config"
- gem "aasm"
+ if aasm_version == "current"
+ gem "aasm"
+ else
+ gem "aasm", "~> #{aasm_version}"
+ end
gem "bcrypt"
gem "xpath"
gem "kredis"Test stub/helper
diff --git a/spec/tapioca/dsl/compilers/aasm_spec.rb b/spec/tapioca/dsl/compilers/aasm_spec.rb
index 52aebda2..d6df99e2 100644
--- a/spec/tapioca/dsl/compilers/aasm_spec.rb
+++ b/spec/tapioca/dsl/compilers/aasm_spec.rb
@@ -14,6 +14,17 @@ module Tapioca
require "aasm"
end
+ # Runs the block with `AASM::VERSION` stubbed, so both the aasm < 6 and
+ # aasm >= 6 code paths can be exercised regardless of the installed version.
+ #: (String version) { -> void } -> void
+ def with_aasm_version(version, &block)
+ original = ::AASM::VERSION
+ ::Tapioca::Runtime.silence_warnings { ::AASM.const_set(:VERSION, version) }
+ block.call
+ ensure
+ ::Tapioca::Runtime.silence_warnings { ::AASM.const_set(:VERSION, original) }
+ end
+
describe "initialize" do
it "gathers no constants if there are no classes that include AASM" do
assert_empty(gathered_constants)
@@ -345,7 +356,7 @@ module Tapioca
end
RUBY
- expected = template(<<~RBI)
+ rbi = <<~RBI
# typed: strong
class StateMachine
@@ -476,7 +487,14 @@ module Tapioca
end
RBI
- assert_equal(expected, rbi_for(:StateMachine))
+ # Assert against the currently installed aasm version.
+ assert_equal(template(rbi), rbi_for(:StateMachine))
+
+ # Also exercise the aasm < 6 code path, which no longer matches the
+ # installed version once aasm >= 6 is in use.
+ with_aasm_version("5.5.2") do
+ assert_equal(template(rbi), rbi_for(:StateMachine))
+ end
end
end
end
Contributor
There was a problem hiding this comment.
Ah my bad. I'm leaning towards not adding a new pipeline just for this, let's keep the support for older aasm versions but skip the tests. Sorry about the extra work, I forgot.
Contributor
Author
There was a problem hiding this comment.
All good, I think I can just revert the last two commits.
KaanOzkan
reviewed
Jul 27, 2026
KaanOzkan
approved these changes
Jul 30, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Fixes #2671. Also see "Migrating from AASM version 5 to 6".
Implementation
The aasm compiler now (a) withholds plain methods when namespaced and on v6 and (b) adds the namespaced
_without_validation!method when on v6.Tests
The compiler test only accommodates the >=v6.0 path (see #2672 for the discussion)